Skip to main content

Get-IMAssetStatistic

SYNOPSIS​

Retrieves Immich asset statistics

SYNTAX​

Get-IMAssetStatistic [[-Session] <ImmichSession>] [[-IsFavorite] <Boolean>] [[-IsTrashed] <Boolean>]
 [[-Visibility] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION​

Retrieves comprehensive statistics about assets in the Immich library, including counts by type, status, and other criteria. Supports filtering by favorite status, trash status, and visibility.

EXAMPLES​

EXAMPLE 1​

Get-IMAssetStatistic

Retrieves comprehensive asset statistics for the entire library.

EXAMPLE 2​

Get-IMAssetStatistic -IsFavorite:$true

Retrieves statistics for favorite assets only.

EXAMPLE 3​

Get-IMAssetStatistic -IsTrashed:$false -Visibility 'timeline'

Retrieves statistics for non-trashed assets visible in the timeline.

EXAMPLE 4​

$stats = Get-IMAssetStatistic
Write-Host "Total images: $($stats.images), Total videos: $($stats.videos)"

Retrieves statistics and displays specific counts.

PARAMETERS​

-Session​

Optionally define an Immich session object to use. This is useful when you are connected to more than one Immich instance.

Type: ImmichSession
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-IsFavorite​

Filter statistics to include only favorite assets (true) or exclude favorites (false). If not specified, includes both.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-IsTrashed​

Filter statistics to include only trashed assets (true) or exclude trashed assets (false). If not specified, includes both.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Visibility​

Filter statistics by asset visibility. Valid values are 'archive', 'timeline', 'hidden', 'locked'.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction​

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters​

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS​

OUTPUTS​

NOTES​

EDIT THIS DOC​

This page was auto-generated from the powershell command comment based help. To edit the content of this page, update the script file comment based help on github Github